/*
 *  Copyright © 2011 by Rob Cash
 * 
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 * 
 *       http://www.apache.org/licenses/LICENSE-2.0
 * 
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 * 
 * Bookmark.java
 * 
 * Created on Jun 20, 2011 at 10:18:57 PM
 */
package org.robcash.apps.bookmarksync.vo;

import java.util.Collection;
import java.util.Date;
import org.robcash.apps.bookmarksync.BookmarkSyncException;

/**
 * Bookmark
 * @author Rob Cash
 */
public interface Bookmark
{
    /**
     * Get the title of the bookmark
     * @return Title of the bookmark
     * @throws BookmarkSyncException Thrown if the title cannot be returned
     */
    String getTitle() throws BookmarkSyncException;
    
    /**
     * Get the URI to which the bookmark refers
     * @return URI to which the bookmark refers
     * @throws BookmarkSyncException Thrown if the URI cannot be returned
     */
    String getURI() throws BookmarkSyncException;

    /**
     * Get the tags associated with the bookmark
     * @return Bookmark tags. This may be empty, but it will never be null.
     * @throws BookmarkSyncException Thrown if the tags cannot be returned
     */
    Collection<Tag> getTags() throws BookmarkSyncException;
    
    /**
     * Get the comments associated with the bookmark
     * @return Comments
     * @throws BookmarkSyncException Thrown if the comments cannot be returned
     */
    String getComments() throws BookmarkSyncException;
    
    /**
     * Get the date when the bookmark was created
     * @return Date when the bookmark was created
     * @throws BookmarkSyncException Thrown if the creation date cannot be
     * returned
     */
    Date getDateCreated() throws BookmarkSyncException;
    
    /**
     * Get the date when the bookmark was created
     * @return Date when the bookmark was created
     * @throws BookmarkSyncException Thrown if the creation date cannot be
     * returned
     */
    Date getDateModified() throws BookmarkSyncException;
    
}
